CategoryFeed

Interfaces

CategoryFeedProps

Properties

category?

optional category: SCCategoryType

Category Object

Default

null

categoryId?

optional categoryId: number

Id of the category for filter the feed

Default

null

className?

optional className: string

Overrides or extends the styles applied to the component.

Default

null

FeedObjectProps?

optional FeedObjectProps: FeedObjectProps

Props to spread to single feed object

Default

empty object

FeedProps?

optional FeedProps: Omit<FeedProps, "endpoint" | "ItemComponent" | "widgets" | "itemPropsGenerator" | "itemIdGenerator" | "ItemSkeleton" | "ItemSkeletonProps" | "FeedSidebarProps">

Props to spread to feed component

Default

{}

FeedSidebarProps?

optional FeedSidebarProps: StickyBoxProps

Props to spread to single feed object

Default

{top: 0, bottomBoundary: `#${id}`}

id?

optional id: string

Id of the feed object

Default

'feed'

widgets?

optional widgets: SCFeedWidgetType[]

Widgets to be rendered into the feed

Default

[CategoriesFollowed, UserFollowed]

Functions

CategoryFeed()

CategoryFeed(inProps): Element

API documentation for the Community-JS Category Feed Template. Learn about the available props and the CSS API.

This component renders a specific category's feed. Take a look at our demo component here

Import

import {CategoryFeed} from '@selfcommunity/react-templates';

Component Name

The name SCCategoryFeedTemplate can be used when providing style overrides in the theme.

CSS

Rule Name	Global class	Description
root	.SCCategoryFeedTemplate-root	Styles applied to the root element.

Parameters

Parameter	Type	Description
inProps	CategoryFeedProps

Returns

Element

---

CategoryFeedSkeleton()

CategoryFeedSkeleton(): Element

API documentation for the Community-JS Category Feed Skeleton Template. Learn about the available props and the CSS API.

Import

import {CategoryFeedSkeleton} from '@selfcommunity/react-templates';

Component Name

The name SCCategoryFeedTemplate-skeleton-root can be used when providing style overrides in the theme.

CSS

Rule Name	Global class	Description
root	.SCCategoryFeedTemplate-skeleton-root	Styles applied to the root element.

Returns

Element